-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Created a new Microsoft.SecurityInsights preview version - Added onboarding & Offboarding endpoints #12757
Created a new Microsoft.SecurityInsights preview version - Added onboarding & Offboarding endpoints #12757
Conversation
Hi, @yuvalshilo Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
Rule | Message |
---|---|
'PUT' operation 'ProductSettings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L185 |
|
Based on the response model schema, operation 'ProductSettings_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L38 |
|
Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L482 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L380 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L408 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: customerManagedKey Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L462 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: eyesOn Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L466 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L507 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Onboard workspace Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L275 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 7 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'SettingList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'UebaProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'OperationsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'Operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"The schema 'ResourceWithEtag' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2021-03-preview-only", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Thank you for your contribution yuvalshilo! We will review the pull request and get back to you soon. |
Swagger Generation Artifacts
|
Hi @yuvalshilo, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Onboard.json
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Outdated
Show resolved
Hide resolved
Don't forget to update the readme with a new tag for the new version |
...ights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json
Outdated
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Show resolved
Hide resolved
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The linting error must be suppressed, otherwise, it will cause failures in every subsequent update. You have previously done this here: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/securityinsights/resource-manager/readme.md#tag-package-2019-01-preview-only
Noted a few other required changes
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Outdated
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json
Outdated
Show resolved
Hide resolved
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
…arding & Offboarding endpoints (Azure#12757) * created new version * fixed comments * fixed errors * fixed prettier * fixedChecks * add readme, fixed custom words * fixedInconsistentSwaggerVersion * fixed readme order * added integer type * fixed validations * fixed reference * removed system data * reset validations * fixed comments * Added system data * moved system data * addedGo * Fixed comments * removed settingsKind Co-authored-by: Yuval Shilo <[email protected]>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
By end of the month (February)
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.